Leadtools Send comments on this topic. | Back to Introduction - All Topics | Help Version 15.3.5
GetRowColumnCompressed(Byte[],UInt16[],Int32,Int32,Int32,Int32) Method
See Also 
Leadtools Namespace > RasterImage Class > GetRowColumnCompressed Method : GetRowColumnCompressed(Byte[],UInt16[],Int32,Int32,Int32,Int32) Method




workBuffer
Optional work buffer. Allocating the work buffer speeds processing if you call this method more than once, because if you do not allocate a work buffer, the method allocates and frees a temporary buffer each time it is called. The size of this buffer should be the same as the BytesPerLine property. Pass a null reference (Nothing in Visual Basic) to runBuffer if you do not want to use a work buffer.
runBuffer
The output buffer, which will be filled with 1-bit compressed image data. Calculate the required size of this buffer as follows: bytes required = (Width + 3) * 2.
runBufferOffset
Index into runBuffer where the get operation should start.
row
The number of the row to retrieve. The first row is 0, and the last row is 1 less than the image height.
column
The column offset within the row to retrieve. The first column offset is 0, and the last column offset is 1 less than the image width.
width
The number of pixels to retrieve.
Retrieves a row (or part of a row) of 1-bit compressed data from an image that has been loaded in its compressed format.

Syntax

Visual Basic (Declaration) 
<CLSCompliantAttribute(False)>
Public Overloads Function GetRowColumnCompressed( _
   ByVal workBuffer() As Byte, _
   ByVal runBuffer() As UShort, _
   ByVal runBufferOffset As Integer, _
   ByVal row As Integer, _
   ByVal column As Integer, _
   ByVal width As Integer _
) As Integer
Visual Basic (Usage)Copy Code
Dim instance As RasterImage
Dim workBuffer() As Byte
Dim runBuffer() As UShort
Dim runBufferOffset As Integer
Dim row As Integer
Dim column As Integer
Dim width As Integer
Dim value As Integer
 
value = instance.GetRowColumnCompressed(workBuffer, runBuffer, runBufferOffset, row, column, width)
C# 
[CLSCompliantAttribute(false)]
public int GetRowColumnCompressed( 
   byte[] workBuffer,
   ushort[] runBuffer,
   int runBufferOffset,
   int row,
   int column,
   int width
)
Managed Extensions for C++ 
[CLSCompliantAttribute(false)]
public: int GetRowColumnCompressed( 
   byte[]* workBuffer,
   ushort[]* runBuffer,
   int runBufferOffset,
   int row,
   int column,
   int width
) 
C++/CLI 
[CLSCompliantAttribute(false)]
public:
int GetRowColumnCompressed( 
   array<byte>^ workBuffer,
   array<ushort>^ runBuffer,
   int runBufferOffset,
   int row,
   int column,
   int width
) 

Parameters

workBuffer
Optional work buffer. Allocating the work buffer speeds processing if you call this method more than once, because if you do not allocate a work buffer, the method allocates and frees a temporary buffer each time it is called. The size of this buffer should be the same as the BytesPerLine property. Pass a null reference (Nothing in Visual Basic) to runBuffer if you do not want to use a work buffer.
runBuffer
The output buffer, which will be filled with 1-bit compressed image data. Calculate the required size of this buffer as follows: bytes required = (Width + 3) * 2.
runBufferOffset
Index into runBuffer where the get operation should start.
row
The number of the row to retrieve. The first row is 0, and the last row is 1 less than the image height.
column
The column offset within the row to retrieve. The first column offset is 0, and the last column offset is 1 less than the image width.
width
The number of pixels to retrieve.

Return Value

The number of pixels processed.

Example

This example demonstrates the low-level methods for accessing 1-bit compressed bitmap data. It demonstrates the ability to get and set partial rows, and the ability to process partial rows in buffer-to-buffer processing. The result of the method is an inverted rectangle in the middle of the image.

Remarks

This method is available in the (Document/Medical only).

This method is useful for working with 1-bit images that are loaded in their compressed formats for faster loading and display.

For more information, refer to Speeding Up 1-Bit Documents.

Requirements

Target Platforms: Microsoft .NET Framework 2.0, Windows 98, Windows NT 4.0, Windows Millennium Edition, Windows 2000, Windows XP Home Edition, Windows XP Professional, Windows Server 2003 family

See Also